package com.gitee.qdbp.general.common.api.settings.basic;

import java.util.List;
import com.gitee.qdbp.able.exception.ServiceException;
import com.gitee.qdbp.able.jdbc.ordering.OrderPaging;
import com.gitee.qdbp.able.jdbc.paging.PageList;
import com.gitee.qdbp.general.common.api.settings.model.SensitiveWordBean;
import com.gitee.qdbp.general.common.api.settings.model.SensitiveWordUpdate;
import com.gitee.qdbp.general.common.api.settings.model.SensitiveWordWhere;

public interface ISensitiveWordBasic {

    /**
     * 敏感词信息查询
     *
     * @param where 查询条件
     * @return 敏感词信息
     * @throws ServiceException 查询失败
     */
    SensitiveWordBean find(SensitiveWordWhere where) throws ServiceException;

    /**
     * 根据敏感词ID查询敏感词信息
     *
     * @param id 敏感词ID
     * @return 敏感词信息
     * @throws ServiceException 查询失败
     */
    SensitiveWordBean findById(String id) throws ServiceException;

    /**
     * 敏感词信息查询
     *
     * @param paging 排序分页条件
     * @return 敏感词信息列表
     * @throws ServiceException 查询失败
     */
    PageList<SensitiveWordBean> list(OrderPaging paging) throws ServiceException;

    /**
     * 敏感词信息查询
     *
     * @param where 查询条件
     * @param paging 排序分页条件
     * @return 敏感词信息列表
     * @throws ServiceException 查询失败
     */
    PageList<SensitiveWordBean> list(SensitiveWordWhere where, OrderPaging paging) throws ServiceException;

    /**
     * 根据敏感词ID查询敏感词信息列表
     *
     * @param ids 敏感词ID列表
     * @return 敏感词信息列表
     * @throws ServiceException 查询失败
     */
    PageList<SensitiveWordBean> listByIds(List<String> ids) throws ServiceException;

    /**
     * 创建敏感词信息
     *
     * @param model 待新增的敏感词信息
     * @return 受影响行数
     * @throws ServiceException 创建失败
     */
    int create(SensitiveWordBean model) throws ServiceException;

    /**
     * 批量创建敏感词信息
     *
     * @param models 待新增的敏感词信息
     * @return 受影响行数
     * @throws ServiceException 创建失败
     */
    int create(List<SensitiveWordBean> models) throws ServiceException;

    /**
     * 修改敏感词信息
     *
     * @param model 待修改的内容
     * @param errorOnUnaffected 受影响行数为0时是否抛异常
     * @return 受影响行数
     * @throws ServiceException 修改失败
     */
    int update(SensitiveWordUpdate model, boolean errorOnUnaffected) throws ServiceException;

    /**
     * 根据敏感词ID删除敏感词信息
     *
     * @param ids 待删除的敏感词信息的敏感词ID
     * @param errorOnRowsNotMatch 删除行数不匹配时是否抛异常
     * @return 删除行数
     * @throws ServiceException 删除失败
     */
    int deleteByIds(List<String> ids, boolean errorOnRowsNotMatch) throws ServiceException;

    /**
     * 根据条件删除敏感词信息
     *
     * @param where 条件
     * @param errorOnUnaffected 删除行数为0时是否抛异常
     * @return 删除行数
     * @throws ServiceException 删除失败
     */
    int delete(SensitiveWordWhere where, boolean errorOnUnaffected) throws ServiceException;

}
